Package com.cisco.pt.mu
Class MUNegotiationMessage
java.lang.Object
com.cisco.pt.impl.LTVImpl
com.cisco.pt.mu.MultiUserMessage
com.cisco.pt.mu.MUNegotiationMessage
- All Implemented Interfaces:
LTV
This is the first message sent by the MU protocol.
This class contains the variables and states for a negotiation with
MU PT. During negotiation the MU API will send this message and
expect a response in a similar format with the negotiated options.
-
Field Summary
Fields inherited from class com.cisco.pt.mu.MultiUserMessage
ePtmpMUMsg, PTMP_TYPE_MUCONIN, PTMP_TYPE_MUCONOUT, PTMP_TYPE_MULINKUPDATE, PTMP_TYPE_MULINKUPDATESTATUS, PTMP_TYPE_MUNAMEUPDATE, PTMP_TYPE_MUNEGOREQ, PTMP_TYPE_MUNEGORESP, PTMP_TYPE_MUPDU, PTMP_TYPE_MUPORTADV, PTMP_TYPE_MUSAVENETREQ, PTMP_TYPE_MUSAVENETRESPFields inherited from interface com.cisco.pt.LTV
AUTH_CHALLENGE_TYPE, AUTH_REQUEST_TYPE, AUTH_RESPONSE_TYPE, AUTH_STATUS_TYPE, DISCONNECT_MESSAGE_TYPE, IPC_ERROR_TYPE, IPC_EVENT_SUBSCRIPTION_TYPE, IPC_EVENT_TYPE, IPC_MESSAGE_TYPE, IPC_RESPONSE_TYPE, KEEP_ALIVE_MESSAGE_TYPE, MULTI_USER_MESSAGE_TYPE, NEGOTIATION_MESSAGE_TYPE -
Constructor Summary
ConstructorsConstructorDescriptionMUNegotiationMessage(String username, UUID uuid) Creates a MUNegotiationMessage. -
Method Summary
Modifier and TypeMethodDescriptionvoidstatic MUNegotiationMessagegetMessage(EncodedBuffer buffer) A deserialization function that creates a new message from a PtmpBuffer object.Returns the username set into this messagegetUuid()Returns the UID set into this messagevoidserialize(EncodedBuffer buffer) Serializes the message into a PtmpBuffer.toString()Converts this message into a string for debugging purposesMethods inherited from class com.cisco.pt.mu.MultiUserMessage
isConInput, isConOutput, isLinkUpdate, isLinkUpdateStatus, isMuMessage, isPDU, isPortAdv, isSaveRequest, isSaveResponseMethods inherited from class com.cisco.pt.impl.LTVImpl
getLength, getMessageId, getNextMessageId, getType, getValue, hasResponse, isEvent, isResponse, setLength, setType, setValue
-
Constructor Details
-
MUNegotiationMessage
Creates a MUNegotiationMessage. This function creates a negotiation message for communicating with PT.- Parameters:
username- The network usernameuuid- The UUID for this instance
-
MUNegotiationMessage
public MUNegotiationMessage()
-
-
Method Details
-
getUuid
Returns the UID set into this message- Returns:
- The UID
-
getUsername
Returns the username set into this message- Returns:
- The Username
-
getMessage
A deserialization function that creates a new message from a PtmpBuffer object.- Parameters:
buffer- The PtmpBuffer to get from- Returns:
- A new instance of a NegotiationMessage class get from the buffer
-
serialize
Serializes the message into a PtmpBuffer.- Parameters:
buffer- The PtmpBuffer to put the message into
-
toString
Converts this message into a string for debugging purposes- Overrides:
toStringin classMultiUserMessage- Returns:
- A string representation of this message
-
encodeTypeAndPayload
- Specified by:
encodeTypeAndPayloadin interfaceLTV- Overrides:
encodeTypeAndPayloadin classLTVImpl- Parameters:
buff- The EncodedBuffer that this object should encode itself into
-